メインコンテンツまでスキップ
バージョン: DAI 7.2

コマンドラインモードでのエージェントの実行(DAIランエージェント)

DAIランエージェントは、ユーザーインターフェイスなしでコマンドラインから設定および実行することができます。

  1. 環境ページのエージェントのインストールトピックの Windows用セクションに記載されている手順に従って、DAI Run Agentをインストールしてください。

  2. コマンドプロンプトからエージェントディレクトリに移動します。例えば:

    • Windowsの場合:C:\Program Files (x86)\eggplantDAIRunAgent\
    • Macの場合:/Applications
    • Linuxの場合:(eggplantDAIRunAgent実行ファイルが抽出されたパス)
  3. エージェント実行ファイルを実行し、適切な引数を追加します:

    • Windowsの場合:eggplantDAIRunAgent.exe [引数]
    • Macの場合:./eggplantDAIRunAgent [引数]
    • Linuxの場合:./eggplantDAIRunAgent [引数]
警告

コマンドウィンドウを介してコマンドライン引数でエージェントを起動する際には注意してください。引数の入力を間違えると、コマンドウィンドウが即座に閉じてしまい、ログは作成されません。

DAIランエージェントの実行例

DAIランエージェントにダウンロードした.iniファイルのパスを提供し、そのファイルに設定が1セクションだけ含まれている場合、追加の引数を提供する必要はありません。MacまたはLinuxベースのシステムのbashシェル端末で、EPFのGUIが必要ない場合は、次の引数でランエージェントを起動できます:

./eggplantDAIRunAgent --ini-file "my envs/my_env.ini"

ファイルパスにスペースが含まれている場合は、引用符で囲む必要があります。

以下は、より詳細ですがオプションの引数を使用して、異なるオペレーティングシステムでDAIランエージェントを実行する例です。.iniファイルに複数のセクションが含まれている場合、DAIデザインエージェントが使用するものとして、--host-url--env-idのみを提供する必要があります。

Windows

cd C:\Program Files (x86)\eggplantDAIRunAgent
eggplantDAIRunAgent.exe --ini-file envs\my_env.ini --host-url https://server.company.com --env-id 1 --gui True --log-level DEBUG

Mac/Linux

./eggplantDAIRunAgent --ini-file envs/my_env.ini --host-url https://server.company.com --env-id 1 --gui True --log-level DEBUG

コマンドライン引数

コマンドライン引数の完全なリスト、使用方法、および機能については、--helpフラグを使用してランナーを起動することで確認できます。

Windowsの場合:

cd C:\Program Files (x86)\eggplantDAIRunAgent
eggplantDAIRunAgent.exe --help

Mac/Linuxの場合:

./eggplantDAIRunAgent --help

以下は、サポートされているコマンドライン引数と対応する環境変数のリストです。

引数環境変数説明
--ini-file FILEDAI_AGENT_INI_FILEDAIサーバーからダウンロードされた環境設定(.ini)ファイルの場所。(.ini)ファイルは、ダウンロードされたiniファイルをロードする際にのみ作成されます。

デフォルト:
Windows: C:\Users\{user}\.eggplantDAI.ini(非表示にマークされています。)
Mac: ~/.eggplantDAI.ini
Linux: ~/.eggplantDAI.ini
--host-url TEXTDAI_HOST_URL接続するEggplant DAIサーバー、例:https://server.company.com。これは、環境設定(.ini)ファイルのhost_urlにマップされます。
--env-idと組み合わせて.iniファイルの適切なセクションを選択するために使用します。
指定されていない場合は、.iniファイルの最初のセクションを使用します。
--env-id INTEGERDAI_EXEC_ENV_IDDAIサーバー上の実行環境のID。
--host-urlと組み合わせて.iniファイルの適切なセクションを選択するために使用します。
指定されていない場合は、.iniファイルの最初のセクションを使用します。
--suite-root DIRECTORYEGGDRIVE_SUITE_ROOTダウンロードされたスイートを保存するためのフォルダ。
Eggplant Functionalスイートは、指定されたルートフォルダのサブルダとしてアップロードおよびダウンロードされます。

デフォルト:
Windows: C:\ProgramData\Eggplant\agent\Suites
Mac: ~/Library/Application Support/agent/suites
Linux: ~/.local/share/agent/suites
--gui [True, False]Eggplant FunctionalのUIを表示するかどうかを指定します。

デフォルト: False
--drive-port INTEGEREGGDRIVE_PORTEggplant FunctionalがeggDriveコマンドをリッスンするために使用するポート。
指定されていない場合は、ランダムに割り当てられた空きポートを使用します。
--epf FILEEGGDRIVE_EXECEggplant Functional runscriptファイルの場所。runscriptファイルはコマンドラインからEggplant Functionalを実行するために使用されます。

デフォルト:
Windows: C:\Program Files\Eggplant\Eggplant.app\runscript.exe
Mac: /Applications/Eggplant.app/Contents/MacOS/runscript
Linux: /usr/local/bin/runscript
--log-level [INFO, DEBUG, TRACE]ログレベル。

INFO: 物事が期待通りに動作していることを確認する基本的なメッセージ。
DEBUG: 問題の診断時に詳細なメッセージを提供します。
TRACE: すべてのレベルのログを表示します。

デフォルト: INFO
--log-folder DIRECTORYDAI_AGENT_LOG_FOLDERログファイルを保存するためのフォルダ。

デフォルト:
Windows: C:\ProgramData\Eggplant\agent\logs
Mac: ~/Library/Logs/agent
Linux: ~/.cache/agent/log
--licenser-host TEXT[オプション] Licenserホストを指定するための追加のEPF引数。
--versionバージョンを表示します。
--helpヘルプメッセージを表示し、終了します。

テスト設定実行のためのEggplant Functional停止および再起動設定

テスト設定を実行する際に、Eggplant Functional(EPF)を再起動するまでの実行時間や、ポーリング停止および再起動のための猶予期間を次の環境変数で設定できます。 詳細はテスト設定実行のためのEggplant Functional停止および再起動設定を参照してください。

環境変数デフォルト説明
RESTART_EPF_AFTER_SECONDS1800テスト構成を実行する際、EPFが再起動する前にEPFが実行される間隔を秒単位で設定できます。この変数は、定義された時間が超過した場合に、現在のステップが終了し、次のステップに移る前に効果を発揮します。これは、DAI Run Agentで実行されるテスト構成にのみ適用されます。ライブ実行中は、EPFは再起動せずに連続して実行されます。テスト実行中にEPFを再起動させたくない場合は、このオプションを0(ゼロ)に設定して無効にすることができます。
EPF_QUIT_POLL_TIME_SECONDS20再起動プロセス中にEPFが終了するための猶予期間。
EPF_RESTART_POLL_TIME_SECONDS120EPFが終了した後に起動するための猶予期間。EPF_RESTART_POLL_TIME_SECONDSにはEPF_QUIT_POLL_TIME_SECONDSは含まれません。